﻿using System;

namespace SBPweb.Forge.Contracts.Events
{

    // Summary:
    //     Provides data for a cancelable event.
    public class CancelEventArgs : EventArgs
    {

        // Summary:
        //     Initializes a new instance of the System.ComponentModel.CancelEventArgs class
        //     with the System.ComponentModel.CancelEventArgs.Cancel property set to false.
        public CancelEventArgs()
        {
        }

        //
        // Summary:
        //     Initializes a new instance of the System.ComponentModel.CancelEventArgs class
        //     with the System.ComponentModel.CancelEventArgs.Cancel property set to the
        //     given value.
        //
        // Parameters:
        //   cancel:
        //     true to cancel the event; otherwise, false.
        public CancelEventArgs(bool cancel)
        {
            Cancel = cancel;
        }

        // Summary:
        //     Gets or sets a value indicating whether the event should be canceled.
        //
        // Returns:
        //     true if the event should be canceled; otherwise, false.
        public bool Cancel
        {
            get;
            set;
        }

    }

}